CIMPLICITY Configuration REST API Web Service
In This Topic
    CIMPLICITY Configuration REST API Web Service
    In This Topic
    All Operations
    Post/createProject
    Creates new project.
    Get/projects/{projectId}
    returns the project name for the given project id
    Get/projects/{projectId}/classes
    returns the list of classes in a project
    Get/projects/{projectId}/devices
    returns an array of devices in the project optionally filtered by port prefix
    Get/projects/{projectId}/historianConnections
    returns a list of historianConnections in a project that satisfy the filter criteria
    Post/projects/{projectId}/historianConnections
    Creates or updates an array of historian connections in the project
    Post/Projects/{projectId}/historianConnections:batchDelete
    Deletes an array of historain connections in the project
    Post/projects/{projectId}/historianConnections:read
    Gets an array of historian connection objects that satisfy the filter criteria specified in the request body.
    Get/projects/{projectId}/objects
    returns a list of objects in a project that satisfy the filter criteria
    Post/projects/{projectId}/objects
    Creates or updates an array of objects in the project
    Post/Projects/{projectId}/objects:batchDelete
    Deletes an array of objects in the project
    Post/projects/{projectId}/objects:read
    Gets an array of class Objects that satisfy the filter criteria specified in the request body.
    Post/projects/{projectId}/operationsHub-settings
    Add or individually modify parameters related to Operations Hub
    Get/projects/{projectId}/points
    Gets an array of point objects that satisfy the query criteria
    Post/projects/{projectId}/points
    Creates or updates an array of points in the project
    Post/Projects/{projectId}/points:batchDelete
    Deletes an array of points in the project
    Post/projects/{projectId}/points:read
    Gets an array of point objects that satisfy the filter criteria specified in the request body.
    Get/projects/{projectId}/resources
    returns a list of resources in a project that satisfy the filter criteria
    Post/projects/{projectId}/resources
    Creates or updates an array of resources in the project
    Post/Projects/{projectId}/resources:batchDelete
    Deletes an array of resources in the project
    Post/projects/{projectId}/resources:read
    Gets an array of resource objects that satisfy the filter criteria specified in the request body.
    Get/projects/{projectId}/roles
    returns a list of roles in a project that satisfy the filter criteria
    Post/projects/{projectId}/roles
    Creates or updates an array of roles in the project
    Post/Projects/{projectId}/roles:batchDelete
    Deletes an array of roles in the project
    Post/projects/{projectId}/roles:read
    Gets an array of role objects that satisfy the filter criteria specified in the request body.
    Get/Projects/{projectId}/runningStatus
    returns a running status of the CIMPLICITY project
    Post/Projects/{projectId}/runningStatus
    start or stop a CIMPLICITY project
    Post/Projects/{projectId}/runningStatus:read
    Deletes an array of objects in the project
    Get/projects/{projectId}/securityGroups
    returns a list of securitygroups in a project that satisfy the filter criteria
    Post/projects/{projectId}/securityGroups
    Creates or updates an array of securityGroups in the project
    Post/Projects/{projectId}/securityGroups:batchDelete
    Deletes an array of securityGroups in the project
    Post/projects/{projectId}/securityGroups:read
    Gets an array of securityGroup objects that satisfy the filter criteria specified in the request body.
    Get/projects/{projectId}/SQLConnections
    Gets an array of SQL connections objects that satisfy the query criteria
    Post/projects/{projectId}/SQLConnections
    Creates or updates an array of sql connections in the project
    Post/projects/{projectId}/SQLConnections:read
    Gets an array of SQL Connections that satisfy the filter criteria specified in the request body.
    Get/projects/{projectId}/users
    returns a list of users in a project that satisfy the filter criteria
    Post/projects/{projectId}/users
    Creates or updates an array of users in the project
    Post/Projects/{projectId}/users:batchDelete
    Deletes an array of users in the project
    Post/projects/{projectId}/users:read
    Gets an array of users objects that satisfy the filter criteria specified in the request body.
    Post/rest-settings
    modifies rest settings of multiple projects
    Get/service-settings
    returns settings that can be used by the client
    Post/user-config
    creates or modifies a user
    Get/versionInfo
    returns version information of the installed CIMPLICITY product
    Json Schemas
    Fields that describe the connection to a SQL connection
    Fields that describe the connection to a SQL connection
    Fields that need to be specified for creating a user before enabling rest configuration for project
    Fields that need to be specified for modifying rest settings of project
    Fields that describe the connection to a historian server
    Fields that describe the resource
    Fields that describe the user
    Fields that describe the role
    Contains the privileges related to security
    Contains the privileges related to configuration security
    Fields that describe the context for referencing an OPC UA Devices NodeIds
    is an object that represents an attribute of an object.
    is an object that represents a dataitem of an object.
    is an object that describe a CIMPLICITY class object instance
    fields that describe a CIMPLICITY point
    Contains the properties pertaining to Derived Point Configuration
    object contains the device information for a CIMPLICITY point.
    object contains the conversion information for converting a point from raw device units to real-world units. Conversion can either be linear or based on a conversion expression
    is a object to configure the expression attributes
    Represents measurement unit.
    Represents a point enum that contains a list of point enum fields.
    Represents a point enum field that associates a text string with an integer point value.
    object contains the point alarm information for a CIMPLICITY point
    object provides an interface to CIMPLICITY Alarm configuration
    object contains the trend point buffering information for a CIMPLICITY point
    result information about each item in a create/update/delete request
     
     
     
     
    Specifies calculation types of points
    Specifies initial value for a global or derived point.
    MMS types
    defines the trigger condition for a device point. See the Point Configuration documentation for additional information
    defines update criteria available for device points. The particular types of update that are actually available depend on the device communication module being used
    Specifies the browser type
    defines different change approval data setting. The numeric value of these enumerations can be used in an expression of a class data item for the $APPROVAL_TYPE field
    defines the deletion options available for an alarm
    defines types of alarming available
    defines the origin types for a point
    defines units for time values
    Response data when a request fails
    The results of the create/update/delete operations.
    CIMPLICITY product's version information.
    The results of the point create/update/delete operations.
    The results of the points get query
    The results of the points get query.
    The results of the historian connections get query.
    The results of the resources get query.
    The results of the roles get query.
    The results of the objects get query
    The results of the users get query.
    The running status of the CIMPLICITY project.
    The results of the Settings Get.
    Information about the CIMPLICITY project
    CIMPLICITY class definition
    CIMPLICITY class definition
    A data item in a class (becomes a point on an object)
    one child composite member of the class
    Filter used for objects
    Filter used for SQL connections
    An object which provides an interface for filters to read point configuration
    An object which provides an interface for filters to read historian connections configuration
    An object which provides an interface for filters to read resources
    An object which provides an interface for filters to read roles
    An object which provides an interface for filters to read users
    Fields that describe the securityGroups
    An object which provides an interface for filters to read SecurityGroupName
    The results of the securityGroups get query.